home *** CD-ROM | disk | FTP | other *** search
/ Compendium Deluxe 2 / LSD and 17bit Compendium Deluxe - Volume II.iso / a / prog / cprog / drchip1_03.lha / DrChip / flist / flist.doc < prev    next >
Encoding:
Text File  |  1994-11-08  |  3.5 KB  |  97 lines
  1.                Flist v2.01 Copyright 1993,1994 Charles E. Campbell, Jr
  2.               ----------------------------------------------------------
  3.  
  4. Copyright:
  5.  
  6.     This program (flist) and associated documents are copyrighted 1993,1994
  7.     by Charles E. Campbell, Jr, PhD.
  8.  
  9.  
  10. Restrictions:
  11.  
  12.     All rights to flist and its documents are reserved, except for those
  13.     explicitly granted herein.
  14.  
  15.     No representation or warranties are made with respect to the accuracy,
  16.     reliability, performance, or operation of this software, and all such
  17.     use is at your own risk.  The author does not assume any responsiblity
  18.     or liability whatsoever with respect to your use of this software.
  19.  
  20.     Flist may not be included with any commercial product nor may it be
  21.     sold for profit either separately or as part of a compilation without
  22.     the permission of Dr. Charles E. Campbell, Jr.  It may be included in
  23.     non-profit disk collections such as the Fred Fish collection.  It may
  24.     be archived and uploaded to electronic bulletin board systems so long
  25.     as all files remain together and unaltered.  It may be copied to and
  26.     used on individuals' computer systems.
  27.  
  28.  
  29. Author : Dr. Charles E. Campbell, Jr.
  30. Contact: cec@gryphon.gsfc.nasa.gov
  31. Version: 2.01
  32.  
  33.  
  34. Usage:
  35.  
  36.     flist [filename1 [filename2 [filename3...]]
  37.     flist "?"
  38.  
  39.  
  40. Options:
  41.     -c : produce output suitable for inclusion in a comment
  42.     -C : no comments next to prototypes, etc
  43.     -d : c++ ctags mode: allow duplication of class::func as func
  44.     -e : etags mode (generates a <TAGS> file)
  45.     -G : only global functions printed (no static)
  46.     -l : include linenumber in comment field
  47.     -m : merge tags with hdrtags if present
  48.     -p : produce prototype declarations without user variables
  49.     -s#: set screenwidth to specified value
  50.     -S : only static functions printed (no global)
  51.     -t : ctags mode: creates a tags file
  52.     -u : produce prototypes with user variables
  53.     -v : print filenames as they're processed
  54.     -x : extern type listing
  55.  
  56.  
  57. Explanation:
  58.  
  59.     Normal output consists of the files' names and a list of functions contained
  60.     therein (for the C and C++ languages). Flist can accept input from the standard
  61.     input.
  62.  
  63.     Optional forms of output include: <tags> file, prototypes, extern style
  64.     (old K&R), and a form suitable for inclusion in a comment.  One may
  65.     restrict the output to globally accessable functions or to local (static)
  66.     ones.
  67.  
  68.     The "ctags" mode supports both C and C++.  The C++ mode generates
  69.     tags by function name as usual, but will also generate tags of the
  70.     form class::func, class::~class, operatorX, where X is an operator,
  71.     and class::operatorX.
  72.  
  73.     The -m option allows the generation of a <tags> file which will contain
  74.     any tags from the local <hdrtags> file in addition to whatever source code
  75.     files were processed by flist.
  76.  
  77.     The <rdcolor.dat> file should be moved to the s: directory.  Set the
  78.     environment variable
  79.  
  80.        setenv ChipData s:
  81.  
  82.     so that the programs can find it.  The file provides a mapping from color
  83.     names to escape sequences, and it should be fairly obvious as to how to
  84.     modify it to suit your requirements.
  85.  
  86.     The hdrtag program was compiled with Aztec C on an A3000 with the following
  87.     options: CCOPTS=-qf -wp -c2 -f8.
  88.  
  89.     Good luck, and let me know of any problems you encounter, and any attaboys
  90.     will be appreciated :).
  91.  
  92.  
  93. New Stuff:
  94.  
  95.     Can generate TAGS files (etags mode)
  96.     Can merge with hdrtag-generated etags mode files (ie. use -me)
  97.